Snapservice ProtectionGroups ComputeMembersSpec
The Snapservice ProtectionGroups ComputeMembersSpec schema is used to provide the create or update configuration spec for a protection group when checking which virtual machines will become protected as part of it. See POST /snapservice/protection-groups?action=compute-members operation
This schema was added in vSphere API 9.1.0.0.
{
"create_spec": {
"name": "string",
"target_entities": {
"vm_name_patterns": [
"string"
],
"vms": [
"string"
],
"tag_rules": [
{
"tags": [
"string"
],
"operator": "string"
}
]
},
"snapshot_policies": [
{
"name": "string",
"schedule": {
"unit": "string",
"interval": 0
},
"retention": {
"unit": "string",
"duration": 0
}
}
],
"locked": false,
"replication_policies": [
{
"cluster_pair": "string",
"recovery_point_objective": {
"unit": "string",
"duration": 0
},
"snapshot_retention": {
"short_term": {
"keep_last": 0
},
"long_term": {
"hourly": {
"retention": {
"unit": "string",
"duration": 0
}
},
"daily": {
"hour": 0,
"retention": {
"unit": "string",
"duration": 0
}
},
"weekly": {
"hour": 0,
"day_of_week": "string",
"retention": {
"unit": "string",
"duration": 0
}
},
"monthly": {
"hour": 0,
"day_of_month": 0,
"retention": {
"unit": "string",
"duration": 0
}
}
}
},
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
},
"target_entity_replication_spec": {
"vm_replication_specs": [
{
"vm": "string",
"config_params": {
"target_config": {
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
}
}
}
}
]
}
}
]
},
"update_spec": {
"name": "string",
"target_entities": {
"vm_name_patterns": [
"string"
],
"vms": [
"string"
],
"tag_rules": [
{
"tags": [
"string"
],
"operator": "string"
}
]
},
"snapshot_policies": [
{
"name": "string",
"schedule": {
"unit": "string",
"interval": 0
},
"retention": {
"unit": "string",
"duration": 0
}
}
],
"replication_policies": [
{
"cluster_pair": "string",
"recovery_point_objective": {
"unit": "string",
"duration": 0
},
"snapshot_retention": {
"short_term": {
"keep_last": 0
},
"long_term": {
"hourly": {
"retention": {
"unit": "string",
"duration": 0
}
},
"daily": {
"hour": 0,
"retention": {
"unit": "string",
"duration": 0
}
},
"weekly": {
"hour": 0,
"day_of_week": "string",
"retention": {
"unit": "string",
"duration": 0
}
},
"monthly": {
"hour": 0,
"day_of_month": 0,
"retention": {
"unit": "string",
"duration": 0
}
}
}
},
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
},
"target_entity_replication_spec": {
"vm_replication_specs": [
{
"vm": "string",
"config_params": {
"target_config": {
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
}
}
}
}
]
}
}
],
"locked": false
},
"protection_group": "string",
"cluster_id": "string"
}
Field createSpec is the spec that would be used to create the protection group.
This property was added in vSphere API 9.1.0.0.
If missing or null, this is not a preview request for creating protection group.
Field updateSpec is the spec that would be used to update the protection group.
This property was added in vSphere API 9.1.0.0.
If missing or null, this is not a preview request for updating protection group.
Identifier of the protection group. Used in combination with updateSpec, indicating the protection group to be updated.
This property was added in vSphere API 9.1.0.0.
If missing or null or empty, createSpec must be set.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.protection_group. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.protection_group.
The cluster on which the protection group is or is going to be created.
This property was added in vSphere API 9.1.0.0.
This field might be removed in future.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.